IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il/ilHwVisual.z/ilHwVisual

Text File | 2002-10-03 | 12.6 KB | 397 lines

iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll - an X Visual

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilHwConnection.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The ilHwVisual object is filled in by the ilHwConnection::findVisual*
     methods. It provides an easy way to decode the attributes of an X Visual.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     XXXX aaaattttttttrrrriiiibbbbuuuutttteeee qqqquuuueeeerrrriiiieeeessss

          XVisualInfo* getVisualInfo()
          GLXFBConfigSGIX getFBConfig()
          Visual* getVisual()
          int getClass()
          VisualID getVisualID()
          int getDepth()
          int getColormapSize()
          unsigned long getRedMask()
          unsigned long getGreenMask()
          unsigned long getBlueMask()

     CCCCoooommmmppppoooonnnneeeennnntttt ssssiiiizzzzeeee qqqquuuueeeerrrriiiieeeessss

          int getComponentSize()
          int getRedSize()
          int getGreenSize()
          int getBlueSize()
          int getAlphaSize()

     VVVViiiissssuuuuaaaallll ccccaaaappppaaaabbbbiiiilllliiiittttyyyy qqqquuuueeeerrrriiiieeeessss

          int isDoubleBuffer()
          int isStereo()
          int isRgb()
          int isColorIndex()
          int doesOpenGL()
          int hasDepth()
          int hasStencil()
          int hasAccum()
          int hasPbuffer()
          int hasAlpha()
          int getVisualAttributes()
          int getLevel()

     MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss




                                                                        PPPPaaaaggggeeee 1111






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          iflColorModel getColorModel()
          int getIndex()
          void markInvalid()
          int isValid()


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     ddddooooeeeessssOOOOppppeeeennnnGGGGLLLL(((())))

          int doesOpenGL()


          This method returns true if the Visual supports OpenGL rendering.

     ggggeeeettttAAAAllllpppphhhhaaaaSSSSiiiizzzzeeee(((())))

          int getAlphaSize()


          This method returns the alpha component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it will be zero since X doesn't support an alpha
          component.

     ggggeeeettttBBBBlllluuuueeeeMMMMaaaasssskkkk(((())))

          unsigned long getBlueMask()


          This method returns the blue mask value from the XVisualInfo.

     ggggeeeettttBBBBlllluuuueeeeSSSSiiiizzzzeeee(((())))

          int getBlueSize()


          This method returns the blue component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it is just derived from the visual depth and class.

     ggggeeeettttCCCCllllaaaassssssss(((())))

          int getClass()


          This return the class of this Visual (e.g. TrueColor, PseudColor,
          etc.).

     ggggeeeettttCCCCoooolllloooorrrrmmmmaaaappppSSSSiiiizzzzeeee(((())))






                                                                        PPPPaaaaggggeeee 2222






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          int getColormapSize()


          This method returns the colormap size from the XVisualInfo.

     ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))

          iflColorModel getColorModel()


          This method returns the IL equivalent color model for this visual.

     ggggeeeettttCCCCoooommmmppppoooonnnneeeennnnttttSSSSiiiizzzzeeee(((())))

          int getComponentSize()


          This method returns the component size of this Visual as seen by X.

     ggggeeeettttDDDDeeeepppptttthhhh(((())))

          int getDepth()


          This method returns the depth of this visual.

     ggggeeeettttFFFFBBBBCCCCoooonnnnffffiiiigggg(((())))

          GLXFBConfigSGIX getFBConfig()


          This method returns the FBConfig for this visual if there is one,
          NULL otherwise.

     ggggeeeettttGGGGrrrreeeeeeeennnnMMMMaaaasssskkkk(((())))

          unsigned long getGreenMask()


          This method returns the green mask value from the XVisualInfo.

     ggggeeeettttGGGGrrrreeeeeeeennnnSSSSiiiizzzzeeee(((())))

          int getGreenSize()


          This method returns the green component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it is just derived from the visual depth and class.






                                                                        PPPPaaaaggggeeee 3333






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



     ggggeeeettttIIIInnnnddddeeeexxxx(((())))

          int getIndex()


          This method returns an index that encodes the 'ilHwVisualAttributes'
          attributes of this visual.  See <il/ilHwConnection.h> for a
          defintion of these attributes.

     ggggeeeettttLLLLeeeevvvveeeellll(((())))

          int getLevel()


          This method returns the level of this visual; zero indicates a
          normal visual, other values are for underlay and overlay visuals.

     ggggeeeettttRRRReeeeddddMMMMaaaasssskkkk(((())))

          unsigned long getRedMask()


          This method returns the red mask value from the XVisualInfo.

     ggggeeeettttRRRReeeeddddSSSSiiiizzzzeeee(((())))

          int getRedSize()


          This method returns the red component size; if OpenGL is supported
          on this visual the value will be the true internal resolution,
          otherwise it is just derived from the visual depth and class.

     ggggeeeettttVVVViiiissssuuuuaaaallll(((())))

          Visual* getVisual()


          This method returns the X Visual* for this ilHwVisual.

     ggggeeeettttVVVViiiissssuuuuaaaallllAAAAttttttttrrrriiiibbbbuuuutttteeeessss(((())))

          int getVisualAttributes()


          This method returns the 'ilHwVisualAttributes' attributes.  See
          <il/ilHwConnection.h> for a defintion of these attributes.

     ggggeeeettttVVVViiiissssuuuuaaaallllIIIIDDDD(((())))






                                                                        PPPPaaaaggggeeee 4444






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          VisualID getVisualID()


          This method returns the VisualID of this visual.

     ggggeeeettttVVVViiiissssuuuuaaaallllIIIInnnnffffoooo(((())))

          XVisualInfo* getVisualInfo()


          This method returns the XVisualInfo* for this visual.

     hhhhaaaassssAAAAccccccccuuuummmm(((())))

          int hasAccum()


          Returns TRUE if this visual has an accumumlation buffer.

     hhhhaaaassssAAAAllllpppphhhhaaaa(((())))

          int hasAlpha()


          Returns TRUE if this visual has an alpha component.

     hhhhaaaassssDDDDeeeepppptttthhhh(((())))

          int hasDepth()


          Returns TRUE if this visual has an depth buffer.

     hhhhaaaassssPPPPbbbbuuuuffffffffeeeerrrr(((())))

          int hasPbuffer()


          Returns TRUE if this visual is usable as a p-buffer.

     hhhhaaaassssSSSStttteeeennnncccciiiillll(((())))

          int hasStencil()


          Returns TRUE if this visual has stencil planes.

     iiiissssCCCCoooolllloooorrrrIIIInnnnddddeeeexxxx(((())))

          int isColorIndex()





                                                                        PPPPaaaaggggeeee 5555






iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllHHHHwwwwVVVViiiissssuuuuaaaallll((((3333))))



          This method returns true if this is a color-index visual.

     iiiissssDDDDoooouuuubbbblllleeeeBBBBuuuuffffffffeeeerrrr(((())))

          int isDoubleBuffer()


          This method returns true if this is a double buffered visual.

     iiiissssRRRRggggbbbb(((())))

          int isRgb()


          This method returns true if this is a TrueColor or DirectColor
          visual.

     iiiissssSSSStttteeeerrrreeeeoooo(((())))

          int isStereo()


          This method returns true if this is a stereo visual.

     iiiissssVVVVaaaalllliiiidddd(((())))

          int isValid()


          This method returns true if this ilHwVisual has been initialized.

     mmmmaaaarrrrkkkkIIIInnnnvvvvaaaalllliiiidddd(((())))

          void markInvalid()


          This method marks this ilHwVisual as uninitialized.















                                                                        PPPPaaaaggggeeee 6666